/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.atlas.ocf.properties;

import java.io.Serializable;

/**
 * A StarRating defines the rating that a user has placed against an asset. This ranges from not recommended
 * through to five stars (excellent).
 */
public enum StarRating implements Serializable
{
    NOT_RECOMMENDED (0, "X", "Not recommended"),
    ONE_STAR        (1, "*", "Poor"),
    TWO_STARS       (2, "**", "Usable"),
    THREE_STARS     (3, "***", "Good"),
    FOUR_STARS      (4, "****", "Very Good"),
    FIVE_STARS      (5, "*****", "Excellent");

    private static final long     serialVersionUID = 1L;

    private int            starRatingCode;
    private String         starRatingSymbol;
    private String         starRatingDescription;


    /**
     * Typical Constructor
     */
    StarRating(int     starRatingCode, String   starRatingSymbol, String   starRatingDescription)
    {
        /*
         * Save the values supplied
         */
        this.starRatingCode = starRatingCode;
        this.starRatingSymbol = starRatingSymbol;
        this.starRatingDescription = starRatingDescription;
    }


    /**
     * Return the code for this enum instance
     *
     * @return int - star rating code
     */
    public int getStarRatingCode()
    {
        return starRatingCode;
    }


    /**
     * Return the default symbol for this enum instance.
     *
     * @return String - default symbol
     */
    public String getStarRatingSymbol()
    {
        return starRatingSymbol;
    }


    /**
     * Return the default description for the star rating for this enum instance.
     *
     * @return String - default description
     */
    public String getStarRatingDescription()
    {
        return starRatingDescription;
    }


    /**
     * Standard toString method.
     *
     * @return print out of variables in a JSON-style
     */
    @Override
    public String toString()
    {
        return "StarRating{" +
                "starRatingCode=" + starRatingCode +
                ", starRatingSymbol='" + starRatingSymbol + '\'' +
                ", starRatingDescription='" + starRatingDescription + '\'' +
                '}';
    }
}